﻿/*
   Copyright 2012 University of Southampton

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace uk.ac.soton.ses
{
    //An abstract class because we can't have an instance of this class
    public abstract class ExperimentDataFileMetadataContainer
    {
        //Fields
        protected ExperimentDataFileBO _experimentDataFile = null;
        protected ExperimentMetadataContainer _parentExperiment = null;

        //Properties
        public ExperimentDataFileBO ExperimentDataFile { get { return this._experimentDataFile; } }

        protected ExperimentDataFileMetadataContainer(ExperimentDataFileBO experimentDataFile, ExperimentMetadataContainer parentExperimentMetadata)
        {
            this._experimentDataFile = experimentDataFile;
            this._parentExperiment = parentExperimentMetadata;
        }

        public virtual void RenameExperimentDataFile(string newName, string newExperimentBasePath)
        {
            this._experimentDataFile.RemainingPath = newName;
            this._experimentDataFile.BasePath = newExperimentBasePath;
            //TODO: We need to also rename ObjectName and ObjectFolder properies. We need to make better use of HDCPath
        }

        public virtual void DeleteExperimentDataFile()
        {
            //Remove myself from the list of files
            this._parentExperiment.ExperimentDataFiles.Remove(this);
        }

        public virtual void UpdateExperimentDataFile(ExperimentDataFileBO updatedExperiment)
        {
            this._experimentDataFile = updatedExperiment.Copy();
        }

        public abstract ExperimentDataFileMetadataContainer Copy();
    }
}